ylru

What is ylru?

The ylru package is a simple and efficient LRU (Least Recently Used) cache implementation in JavaScript. It is designed to help manage a cache of items with a fixed size, automatically removing the least recently used items when the cache exceeds its capacity. This is particularly useful in applications where memory management and data retrieval efficiency are critical.

What are ylru's main functionalities?

Create and manage an LRU cache

This feature allows the user to create a cache with a specified limit and perform basic operations such as setting, getting, checking, and deleting items, as well as retrieving the size of the cache.

const YLRU = require('ylru');
let cache = new YLRU(100); // Create a cache that can hold 100 items
// Set items in the cache
cache.set('key1', 'value1');
cache.set('key2', 'value2');
// Get an item from the cache
let value = cache.get('key1'); // returns 'value1'
// Check if a key exists in the cache
let exists = cache.has('key1'); // returns true
// Remove an item from the cache
cache.delete('key2');
// Get the number of items in the cache
let size = cache.size(); // returns 1

Other packages similar to ylru

lru-cache

lru-cache is another popular LRU cache implementation. It offers additional features such as item expiration based on time, which ylru does not support. This makes lru-cache suitable for scenarios where cache items should expire after a certain duration.

node-cache

node-cache is a more general caching library that supports both LRU mechanism and other types of cache strategies. Unlike ylru, which is specifically focused on LRU, node-cache provides a more flexible solution for various caching needs.

README

ylru

hashlru inspired

hashlru is the Simpler, faster LRU cache algorithm. Please checkout algorithm and complexity on hashlru.

ylru extends some features base on hashlru:

• cache value can be expired.
• cache value can be empty value, e.g.: null, undefined, '', 0

Usage

const LRU = require('ylru');

const lru = new LRU(100);
lru.set(key, value);
lru.get(key);

// value2 will be expired after 5000ms
lru.set(key2, value2, { maxAge: 5000 });
// get key and update expired
lru.get(key2, { maxAge: 5000 });

API

LRU(max) => lru

initialize a lru object.

lru.get(key[, options]) => value | null

• {Number} options.maxAge: update expire time when get, value will become undefined after maxAge pass.

Returns the value in the cache.

lru.set(key, value[, options])

• {Number} options.maxAge: value will become undefined after maxAge pass. If maxAge not set, value will be never expired.

Set the value for key.

lru.keys()

Get all unexpired cache keys from lru, due to the strategy of ylru, the keys' length may greater than max.

const lru = new LRU(3);
lru.set('key 1', 'value 1');
lru.set('key 2', 'value 2');
lru.set('key 3', 'value 3');
lru.set('key 4', 'value 4');

lru.keys(); // [ 'key 4', 'key 1', 'key 2', 'key 3']
// cache: {
//   'key 4': 'value 4',
// }
// _cache: {
//   'key 1': 'value 1',
//   'key 2': 'value 2',
//   'key 3': 'value 3',
// }

lru.reset()

reset a lru object.

const lru = new LRU(3);
lru.set('key 1', 'value 1');
lru.set('key 2', 'value 2');
lru.set('key 3', 'value 3');
lru.set('key 4', 'value 4');

lru.reset();
// cache: {
// }
// _cache: {
// }

lru.keys().length === 0;

License

MIT

Contributors

dominictarr	fengmk2	dead-horse	mourner	vagusX	RaoHai

This project follows the git-contributor spec, auto updated at Wed Mar 16 2022 23:57:13 GMT+0800.

Changelog

1.4.0 (2024-03-28)

Features

• add reset method (#10) (39ebcec)

---

1.3.2 / 2022-03-17

others

• [eda13ec] - test: update toolchains, add tsd test cases (raohai.rh <[e-mail]>)
• [b683526] - 🤖 TEST: Create codeql-analysis.yml (#7) (fengmk2 <[e-mail]>)
• [db06032] - 🤖 TEST: Run on github action (#6) (fengmk2 <[e-mail]>)

1.3.1 / 2022-03-16

fixes

• [18f576e] - fix: module declares (#5) (陆沉 <[e-mail]>)

1.3.0 / 2022-03-16

features

• [6ed8fa0] - feat: add d.ts (#4) (vagusX <[e-mail]>)

1.2.1 / 2018-07-11

others

• [475abb0] - perf: only call Date.now() when necessary (#3) (Yiyu He <[e-mail]>)

1.2.0 / 2017-07-18

• feat: support lru.keys (#2)

1.1.0 / 2017-07-04

• feat: support get with maxAge (#1)

1.0.0 / 2016-12-29

• init version